<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Embroidermodder: About</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js", "TeX/AMSmath.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="logo_embroidermodder_2_0.png"/></td>
  <td id="projectalign">
   <div id="projectname">Embroidermodder<span id="projectnumber">&#160;2.0.0-alpha4</span>
   </div>
   <div id="projectbrief">A free and open source software for machine embroidery</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('about.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">About </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="the-embroidermodder-team"></a>
The Embroidermodder Project and Team</h1>
<p >The <em>Embroidermodder 2</em> project is a collection of small software utilities for manipulating, converting and creating embroidery files in all major embroidery machine formats. The program <em>Embroidermodder 2</em> itself is a larger graphical user interface (GUI) which is at the heart of the project.</p>
<p >The tools and associated documents are:</p>
<ul>
<li>This website (<a href="https://www.libembroidery.org"><code>www.libembroidery.org</code></a>), which is maintained <a href="https://github.com/Embroidermodder/www.libembroidery.org">here</a>.</li>
<li><a href="https://www.libembroidery.org/embroidermodder_2.0_manual.pdf">The manual</a> covering all these projects.</li>
<li>The GUI (<code>embroidermodder</code>), maintained <a href="https://github.com/Embroidermodder/embroidermodder">here</a>.</li>
<li>The core library of low-level functions: <a href="https://github.com/Embroidermodder/libembroidery">libembroidery</a>.</li>
<li>The CLI <code>embroider</code> which is part of <a href="https://github.com/Embroidermodder/libembroidery">libembroidery</a>.</li>
<li>Mobile embroidery format viewers and tools (<a href="https://github.com/Embroidermodder/embroiderymobile"><code>EmbroideryMobile</code></a>)).</li>
<li>Specs for an open hardware embroidery machine called Embroiderbot (not started yet) which is also part of <a href="https://github.com/Embroidermodder/libembroidery">libembroidery</a>.</li>
</ul>
<p >They all tools to make the standard user experience of working with an embroidery machine better without expensive software which is locked to specific manufacturers and formats. But ultimately we hope that the core <em>Embroidermodder 2</em> is a practical, ever-present tool in larger workshops, small cottage industry workshops and personal hobbyist's bedrooms.</p>
<p >Embroidermodder 2 is licensed under the zlib license and we aim to keep all of our tools open source and free of charge. If you would like to support the project check out our <a href="https://opencollective.com/embroidermodder">Open Collective</a> group. If you would like to help, please join us on GitHub. This document is written as developer training as well helping new users (see the last sections) so this is the place to learn how to start changing the code.</p>
<p >The Embroidermodder Team is the collection of people who've submitted patches, artwork and documentation to our three projects. The team was established by Jonathan Greig and Josh Varga. The full list is actively maintained below.</p>
<h2><a class="anchor" id="core-development-team"></a>
"Core Development Team"</h2>
<p >Embroidermodder 2:</p>
<ul>
<li><a href="https://github.com/redteam316">Jonathan Greig</a></li>
<li><a href="https://github.com/JoshVarga">Josh Varga</a></li>
<li><a href="https://github.com/robin-swift">Robin Swift</a></li>
</ul>
<p >Embroidermodder 1:</p>
<ul>
<li><a href="https://github.com/JoshVarga">Josh Varga</a></li>
<li><a href="http://sourceforge.net/u/mpontius/profile">Mark Pontius</a></li>
</ul>
<h1><a class="anchor" id="Credits"></a>
for Embroidermodder 2, libembroidery and all other related code</h1>
<p >If you have contributed and wish to be added to this list, alter the <a href="https://github.com/Embroidermodder/Embroidermodder">README on Embroidermodder github page</a> and we'll copy it to the libembroidery source code since that is credited to "The Embroidermodder Team".</p>
<h2><a class="anchor" id="embroidermodder-1"></a>
Embroidermodder 1</h2>
<p >The Embroidermodder Team is also inspired by the original Embroidermodder that was built by Mark Pontius and the same Josh Varga on SourceForge which unfortunately appears to have died from linkrot. We may create a distribution on here to be the official "legacy" Embroidermodder code but likely in a seperate repository because it's GNU GPL v3 and this code is written to be zlib (that is, permissive licensed) all the way down.</p>
<p >One reason why this is useful is that the rewrite by Jonathan Greig, John Varga and Robin Swift for Embroidermodder 2 should have no regressions: no features present in v1 should be missing in v2.</p>
<h2><a class="anchor" id="features"></a>
Features</h2>
<p >Embroidermodder 2 has many advanced features that enable you to create awesome designs quicker, tweak existing designs to perfection, and can be fully customized to fit your workflow.</p>
<p >A summary of these features:</p>
<ul>
<li>Cross Platform</li>
<li>Realistic rendering</li>
<li>Various grid types and auto-adjusting rulers</li>
<li>Many measurement tools</li>
<li>Add text to any design</li>
<li>Supports many formats</li>
<li>Batch Conversion</li>
<li>Scripting API</li>
</ul>
<h3><a class="anchor" id="cross-platform"></a>
Cross Platform</h3>
<p >If you use multiple operating systems, it's important to choose software that works on all of them.</p>
<p >Embroidermodder 2 runs on Windows, Linux and Mac OS X. Let's not forget the <a href="http://www.raspberrypi.org">Raspberry Pi</a>.</p>
<p ><img src="images/features-platforms-1.png" alt="features: platforms 1" class="inline"/></p>
<h3><a class="anchor" id="section"></a>
Realistic Rendering</h3>
<p >It is important to be able to visualize what a design will look like when stitched and our pseudo `&lsquo;3D&rsquo;' realistic rendering helps achieve this.</p>
<p >Realistic rendering sample #1:</p>
<p ><img src="images/features-realrender-1.png" alt="features real render 1" class="inline"/></p>
<p >Realistic rendering sample #2:</p>
<p ><img src="images/features-realrender-2.png" alt="features real render 2" class="inline"/></p>
<p >Realistic rendering sample #3:</p>
<p ><img src="images/features-realrender-3.png" alt="features real render 3" class="inline"/></p>
<p >Various grid types and auto-adjusting rulers</p>
<p >Making use of the automatically adjusting ruler in conjunction with the grid will ensure your design is properly sized and fits within your embroidery hoop area.</p>
<p >Use rectangular, circular or isometric grids to construct your masterpiece!</p>
<p >Multiple grids and rulers in action:</p>
<p ><img src="images/features-grid-ruler-1.png" alt="features grid ruler" class="inline"/></p>
<h3><a class="anchor" id="section"></a>
Realistic Rendering</h3>
<p >Taking measurements is a critical part of creating great designs. Whether you are designing mission critical embroidered space suits for NASA or some other far out design for your next meet-up, you will have precise measurement tools at your command to make it happen. You can locate individual points or find distances between any 2 points anywhere in the design!</p>
<p >Take quick and accurate measurements:</p>
<p ><img src="images/features-measure-1.png" alt="features measure 1" class="inline"/></p>
<h3><a class="anchor" id="add-text-to-any-design"></a>
Add text to any design</h3>
<p >Need to make company apparel for all of your employees with individual names on them? No sweat. Just simply add text to your existing design or create one from scratch, quickly and easily. Didn't get it the right size or made a typo? No problem. Just select the text and update it with the property editor.</p>
<p >Add text and adjust its properties quickly:</p>
<p ><img src="images/features-text-1.png" alt="features text 1" class="inline"/></p>
<h3><a class="anchor" id="supports-many-formats"></a>
Supports many formats</h3>
<p >Embroidery machines all accept different formats. There are so many formats available that it can sometimes be confusing whether a design will work with your machine.</p>
<p >Embroidermodder 2 supports a wide variety of embroidery formats as well as several vector formats, such as SVG and DXF. This allows you to worry less about which designs you can use.</p>
<h3><a class="anchor" id="batch-conversion"></a>
Batch Conversion</h3>
<p >Need to send a client several different formats? Just use libembroidery-convert, our command line utility which supports batch file conversion.</p>
<p >There are a multitude of formats to choose from:</p>
<p ><img src="images/features-formats-1.png" alt="features formats" class="inline"/></p>
<h3><a class="anchor" id="scripting-api"></a>
Scripting API</h3>
<p >If you've got programming skills and there is a feature that isn't currently available that you absolutely cannot live without, you have the capability to create your own custom commands for Embroidermodder 2. We provide an QtScript API which exposes various application functionality so that it is possible to extend the application without requiring a new release. If you have created a command that you think is worth including in the next release, just <a href="contact.html">contact us</a> and we will review it for functionality, bugs, and finally inclusion.</p>
<p >An Embroidermodder 2 command excerpt:</p>
<p ><img src="images/features-scripting-1.png" alt="scripting screenshot" class="inline"/></p>
<h2><a class="anchor" id="build-and-install"></a>
"Build and Install"</h2>
<p >Assuming you already have the SDL2 libraries you can proceed to using the fast build, which assumes you want to build and test locally.</p>
<p >The fast build should be: </p><pre class="fragment">bash build.sh
</pre><p> or, on Windows: </p><pre class="fragment">.\build.bat
</pre><p> Then run using the <code>run.bat</code> or <code>run.sh</code> scripts in the build/ directory.</p>
<p >Otherwise, follow the instructions below.</p>
<p >If you plan to install the dev version to your system (we recommend you wait for the official installers and beta release first) then use the CMake build instead.</p>
<h3><a class="anchor" id="install-desktop"></a>
Install on Desktop</h3>
<p >We recommend that if you want to install the development version you use the CMake build. Like this: </p><pre class="fragment">git submodule init
git submodule update

mkdir build
cd build
cmake ..
cmake --build .
sudo cmake --install .
</pre><p> These lines are written into the file: </p><pre class="fragment">./build_install.sh
</pre><p> On Windows use the next section.</p>
<h2><a class="anchor" id="history"></a>
History</h2>
<p >Embroidermodder 1 was started by Mark Pontius in 2004 while staying up all night with his son in his first couple months. When Mark returned to his day job, he lacked the time to continue the project. Mark made the decision to focus on his family and work, and in 2005, Mark gave full control of the project to Josh Varga so that Embroidermodder could continue its growth.</p>
<p >Embroidermodder 2 was conceived in mid 2011 when Jonathan Greig and Josh Varga discussed the possibility of making a cross-platform version. It is currently in active development and will run on GNU/Linux, Mac OS X, Microsoft Windows and Raspberry Pi.</p>
<p >All <a href="downloads.html">Embroidermodder downloads</a> are hosted on SourceForge.</p>
<p >The <a href="http://sourceforge.net/p/embroidermodder/code/HEAD/tree/embroidermodder1">source code for Embroidermodder 1</a> has always been hosted on Sourceforge.</p>
<p >The <a href="https://github.com/Embroidermodder/Embroidermodder">source code for Embroidermodder 2</a> was moved to GitHub on July 18, 2013.</p>
<p >The <a href="https://github.com/Embroidermodder/www.libembroidery.org">website for Embroidermodder</a> was moved to GitHub on September 9, 2013.</p>
<h1><a class="anchor" id="contact-us"></a>
Contact us</h1>
<p >For general questions email: <a href="#" onclick="location.href='mai'+'lto:'+'emb'+'ro'+'ide'+'rm'+'odd'+'er'+'@gm'+'ai'+'l.c'+'om'; return false;">embroidermodder at gmail.com</a></p>
<p >To request a new feature <a href="https://github.com/Embroidermodder/Embroidermodder/issues">open an issue on the main Embroidermodder GitHub repository</a>. We'll move it to the correct repository. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
  </ul>
</div>
</body>
</html>
